Blogpost for Introduction to Dashboard plugins #560

ashwin-pc · 2021-12-09T00:47:15Z

Signed-off-by: Ashwin Pc ashwinpc@amazon.com

Description

Follow-up post to #526 covering Opensearch Dashboard plugins this time

Issues Resolved

#446

Check List

Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the BSD-3-Clause License.

saratvemulapalli · 2021-12-09T00:50:48Z

_posts/2021-12-10-dashboards-plugins-intro.markdown

+title: "Introduction to OpenSearch Dashboard Plugins"
+authors:
+  - ashwinpc
+  - vemsarat


I didn't contribute much to deserve credits :). I believe you should be the sole author.

saratvemulapalli

I did one pass, couple of comments.

saratvemulapalli · 2021-12-09T01:00:16Z

_posts/2021-12-10-dashboards-plugins-intro.markdown

+  description: "Plugins are fundamental to how Opensearch works, and that similarity extends to OpenSearch Dashboards too..."
+---
+
+Plugins are fundamental to how Opensearch works, and that similarity extends to OpenSearch Dashboards too. All major components and services used within Dashboards is a plugin. Similar to OpenSearch, additional functionality can also be added using external plugins. As a follow up the blog post on how plugins work for Opensearch, in this post we will explore how plugins work for OpenSearch Dashboards.


that -> the
Not a grammatical expert, but some how it feels the would be better.

"All major components and services used within Dashboards is a plugin"
As a reader I don't know what these components and services are. It would be helpful to explain them.

The sentence starts with plural forms and converges with singular form. Probably something like ... Dashboards are plugins.

"additional functionality can also be added using external plugins"
Do we have internal and external plugins? Are they treated differently across the system?

Thanks for the feedback Sarat, I'll incorporate this feedback with any others in the next revision.

I've redone this paragraph to make it easier to understand while keeping it short so that i can focus on what a plugin is sooner.

stockholmux

Super good blog post!
Most of my comments are style.

A few general comments:

Should you say that this is in typescript at the start?
There is no mention of packaging a plugin for distribution. Is there anything that can be said about that?

_posts/2021-12-10-dashboards-plugins-intro.markdown

stockholmux · 2022-01-06T22:25:28Z

_posts/2021-12-10-dashboards-plugins-intro.markdown

+
+### What is a plugin
+
+First lets understand what an Opensearch Dashboards plugin is. In Opensearch Dashboards, plugins are classes that can be loaded via the [Dashboards plugin api](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/1.2/src/core/CONVENTIONS.md#plugin-structure) to integrate with the core system via lifecycle events. They can consist of a client side code (public), server side code (server), or both. Plugins can also interact on each other and core from both places. Plugins must also contain a manifest file that describes a set of properties, both required and optional that core system can use to load and initialize the plugin correctly.


'Openseach' -> 'OpenSearch'

'lets' should be 'let's' but that is a contraction for 'let us' which is not ideal. Maybe reframe the sentence to: "First, it's important to establish what a OpenSearch Dashboard plugin is'

'api' -> 'API'

Is there a link you can provide to what a lifecycle event is?

'They' means lifecycle events? It's not clear. I'd be more explicit.

'(public)' and '(server)' - are these some sort of reserved word?

'Openseach' -> 'OpenSearch'

done

'lets' should be 'let's' but that is a contraction for 'let us' which is not ideal. Maybe reframe the sentence to: "First, it's important to establish what a OpenSearch Dashboard plugin is'

done

'api' -> 'API'

done

Is there a link you can provide to what a lifecycle event is?

Unfortunately we dont have any documentation i can point to about it, but ive talked about it later in the post. Ive updated the text to link to that section

'They' means lifecycle events? It's not clear. I'd be more explicit.

done

'(public)' and '(server)' - are these some sort of reserved word?

Kinda. They are the reserved names for the folder for client side and server side code. (as shown in the folder structure below)

_posts/2021-12-10-dashboards-plugins-intro.markdown

_authors/ashwinpc.markdown

ashwin-pc · 2022-01-12T11:40:34Z

Created a new issue #619 to track this PR. @stockholmux will update the post in a slightly different format keeping in mind your feedback.

stockholmux · 2022-01-12T15:36:21Z

@ashwin-pc Are you going to update this PR or create a new one? Not sure how much your blog post will change.

ashwin-pc · 2022-01-12T20:38:08Z

@ashwin-pc Are you going to update this PR or create a new one? Not sure how much your blog post will change.

I'm going to update this PR to preserve the comments. Hopefully not a lot. Mostly just the structure.

ashwin-pc · 2022-01-13T04:23:41Z

A few general comments:

Should you say that this is in typescript at the start?

There is no mention of packaging a plugin for distribution. Is there anything that can be said about that?

I don't think its necessary but i don't have a strong opinion either way. Typescript is the language of choice for OSD though, so it should be pretty obvious why the examples are in Typescript.
Ive added a section for that. I've only mentioned how to generate the distributable though. Is there a way for them to publish these plugins currently that i should cover as well? I'm only aware of the plugins we list on the documentation website and those are under the opensearch-project org.

stockholmux

Nothing big - a few small changes and clarifications needed

_posts/2022-01-21-dashboards-plugins-intro.markdown

stockholmux · 2022-01-14T15:39:15Z

_posts/2022-01-21-dashboards-plugins-intro.markdown

+
+The manifest file signature is defined by the interface [`PluginManifest`](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/1.2/src/core/server/plugins/types.ts#L126-L196)
+
+e.g. manifest file


drop this line

Just to be sure, you're asking me to drop only line 76 right?

_posts/2022-01-21-dashboards-plugins-intro.markdown

Signed-off-by: Ashwin Pc <ashwinpc@amazon.com>

stockholmux

LGTM

stockholmux · 2022-01-20T22:53:13Z

Awesome post @ashwin-pc! It really came together.

I'm going to queue this up for tomorrow (1/21). I'll merge it then.

saratvemulapalli · 2022-01-20T22:55:38Z

+1 I really loved reading through it!

ashwin-pc requested a review from a team as a code owner December 9, 2021 00:47

saratvemulapalli reviewed Dec 9, 2021

View reviewed changes

saratvemulapalli requested review from stockholmux and dblock December 9, 2021 00:51

saratvemulapalli reviewed Dec 9, 2021

View reviewed changes

dblock force-pushed the main branch from 70ceade to d316f0b Compare December 22, 2021 18:45

stockholmux suggested changes Jan 6, 2022

View reviewed changes

ashwin-pc force-pushed the dashboard-plugin-intro branch from 9dd7741 to 59f3b56 Compare January 13, 2022 04:28

stockholmux suggested changes Jan 14, 2022

View reviewed changes

ashwin-pc added 3 commits January 20, 2022 21:52

Blogpost for Introduction to Dashboard plugins

ccdff62

Signed-off-by: Ashwin Pc <ashwinpc@amazon.com>

Blogpost: Intro to Dashboard plugins changes

06dd04b

Signed-off-by: Ashwin Pc <ashwinpc@amazon.com>

Blogpost: Intro to Dashboard plugins changes 2

2b6d9ae

Signed-off-by: Ashwin Pc <ashwinpc@amazon.com>

ashwin-pc force-pushed the dashboard-plugin-intro branch from 587a738 to 2b6d9ae Compare January 20, 2022 21:53

stockholmux approved these changes Jan 20, 2022

View reviewed changes

stockholmux merged commit b2580c8 into opensearch-project:main Jan 21, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Blogpost for Introduction to Dashboard plugins #560

Blogpost for Introduction to Dashboard plugins #560

ashwin-pc commented Dec 9, 2021

saratvemulapalli Dec 9, 2021 •

edited

Loading

saratvemulapalli left a comment

saratvemulapalli Dec 9, 2021

saratvemulapalli Dec 9, 2021

saratvemulapalli Dec 9, 2021

ashwin-pc Dec 16, 2021

ashwin-pc Jan 13, 2022

stockholmux left a comment

stockholmux Jan 6, 2022

ashwin-pc Jan 13, 2022

ashwin-pc commented Jan 12, 2022

stockholmux commented Jan 12, 2022

ashwin-pc commented Jan 12, 2022

ashwin-pc commented Jan 13, 2022

stockholmux left a comment

stockholmux Jan 14, 2022

ashwin-pc Jan 18, 2022

stockholmux left a comment

stockholmux commented Jan 20, 2022

saratvemulapalli commented Jan 20, 2022


		### What is a plugin

		First lets understand what an Opensearch Dashboards plugin is. In Opensearch Dashboards, plugins are classes that can be loaded via the [Dashboards plugin api](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/1.2/src/core/CONVENTIONS.md#plugin-structure) to integrate with the core system via lifecycle events. They can consist of a client side code (public), server side code (server), or both. Plugins can also interact on each other and core from both places. Plugins must also contain a manifest file that describes a set of properties, both required and optional that core system can use to load and initialize the plugin correctly.


		The manifest file signature is defined by the interface [`PluginManifest`](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/1.2/src/core/server/plugins/types.ts#L126-L196)

		e.g. manifest file

Blogpost for Introduction to Dashboard plugins #560

Blogpost for Introduction to Dashboard plugins #560

Conversation

ashwin-pc commented Dec 9, 2021

Description

Issues Resolved

Check List

saratvemulapalli Dec 9, 2021 • edited Loading

Choose a reason for hiding this comment

saratvemulapalli left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stockholmux left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ashwin-pc commented Jan 12, 2022

stockholmux commented Jan 12, 2022

ashwin-pc commented Jan 12, 2022

ashwin-pc commented Jan 13, 2022

stockholmux left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stockholmux left a comment

Choose a reason for hiding this comment

stockholmux commented Jan 20, 2022

saratvemulapalli commented Jan 20, 2022

saratvemulapalli Dec 9, 2021 •

edited

Loading